<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Static configuration functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__hppass__cfg__functions.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Static configuration functions<div class="ingroups"><a class="el" href="group__group__hppass.html">HPPASS       (High Performance Programmable Analog Sub-System)</a> &raquo; <a class="el" href="group__group__hppass__common.html">Common</a> &raquo; <a class="el" href="group__group__hppass__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8d22889d8dd8c3fd87df1db2869a6956"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__cfg__functions.html#ga8d22889d8dd8c3fd87df1db2869a6956">Cy_HPPASS_Init</a> (const <a class="el" href="structcy__stc__hppass__cfg__t.html">cy_stc_hppass_cfg_t</a> *cfg)</td></tr>
<tr class="memdesc:ga8d22889d8dd8c3fd87df1db2869a6956"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the entire HPPASS block including AC, STT, CSG and SAR according to the provided settings.  <a href="#ga8d22889d8dd8c3fd87df1db2869a6956">More...</a><br /></td></tr>
<tr class="separator:ga8d22889d8dd8c3fd87df1db2869a6956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga96d3f95d6f156ebfa816a43c3f98ef44"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__cfg__functions.html#ga96d3f95d6f156ebfa816a43c3f98ef44">Cy_HPPASS_DeInit</a> (void)</td></tr>
<tr class="memdesc:ga96d3f95d6f156ebfa816a43c3f98ef44"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initializes the AC, STT, AREF, SAR, CSG, and triggers register values to default.  <a href="#ga96d3f95d6f156ebfa816a43c3f98ef44">More...</a><br /></td></tr>
<tr class="separator:ga96d3f95d6f156ebfa816a43c3f98ef44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga862fd1dd5ae54da1c040976abd98a62f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__cfg__functions.html#ga862fd1dd5ae54da1c040976abd98a62f">Cy_HPPASS_DeepSleepCallback</a> (<a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> *callbackParams, <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a> <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:ga862fd1dd5ae54da1c040976abd98a62f"><td class="mdescLeft">&#160;</td><td class="mdescRight">DeepSleep callback saves the SAR ADC calibration values before switch to deep sleep power mode and restore them after the wakeup.  <a href="#ga862fd1dd5ae54da1c040976abd98a62f">More...</a><br /></td></tr>
<tr class="separator:ga862fd1dd5ae54da1c040976abd98a62f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa070f2bab6825033bdc4e2340bf1e282"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__cfg__functions.html#gaa070f2bab6825033bdc4e2340bf1e282">Cy_HPPASS_TriggerInConfig</a> (uint8_t trigIdx, const <a class="el" href="structcy__stc__hppass__trig__in__t.html">cy_stc_hppass_trig_in_t</a> *trig)</td></tr>
<tr class="memdesc:gaa070f2bab6825033bdc4e2340bf1e282"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the input trigger type and operation mode.  <a href="#gaa070f2bab6825033bdc4e2340bf1e282">More...</a><br /></td></tr>
<tr class="separator:gaa070f2bab6825033bdc4e2340bf1e282"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31038e030330501dc11d754b27c6671d"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__cfg__functions.html#ga31038e030330501dc11d754b27c6671d">Cy_HPPASS_TriggerOutLevelConfig</a> (uint8_t trigIdx, const <a class="el" href="structcy__stc__hppass__trig__out__level__t.html">cy_stc_hppass_trig_out_level_t</a> *trig)</td></tr>
<tr class="memdesc:ga31038e030330501dc11d754b27c6671d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the LEVEL trigger output configuration.  <a href="#ga31038e030330501dc11d754b27c6671d">More...</a><br /></td></tr>
<tr class="separator:ga31038e030330501dc11d754b27c6671d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0401394988141183f29513df37860040"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hppass__cfg__functions.html#ga0401394988141183f29513df37860040">Cy_HPPASS_TriggerOutPulseConfig</a> (uint8_t trigIdx, <a class="el" href="group__group__hppass__enums.html#gae8be0bf60b1685e83512c352328b34cc">cy_en_hppass_trig_out_pulse_t</a> trig)</td></tr>
<tr class="memdesc:ga0401394988141183f29513df37860040"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the PULSE trigger output configuration.  <a href="#ga0401394988141183f29513df37860040">More...</a><br /></td></tr>
<tr class="separator:ga0401394988141183f29513df37860040"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8d22889d8dd8c3fd87df1db2869a6956"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d22889d8dd8c3fd87df1db2869a6956">&#9670;&nbsp;</a></span>Cy_HPPASS_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t Cy_HPPASS_Init </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structcy__stc__hppass__cfg__t.html">cy_stc_hppass_cfg_t</a> *&#160;</td>
          <td class="paramname"><em>cfg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the entire HPPASS block including AC, STT, CSG and SAR according to the provided settings. </p>
<dl class="section note"><dt>Note</dt><dd>If AC is running or SAR or CSG is already enabled, the initialization of the overall HPPASS is not allowed (<a class="el" href="group__group__hppass__enums.html#gga14c32a49b351302efcaf56b2e5075e00a7f6c5e025421582710cadfffcada200c">CY_HPPASS_AC_INVALID_STATE</a> will be returned). The only way to reinitialize the entire HPPASS is only after <a class="el" href="group__group__hppass__cfg__functions.html#ga96d3f95d6f156ebfa816a43c3f98ef44">Cy_HPPASS_DeInit</a> call. Despite the 'block ready' status, the particular SAR or SCG subsystem, which is not running at the moment, can be reinitialized using <a class="el" href="group__group__hppass__sar__functions.html#ga60bb35c82a4f96e3c1a986c8b423ef99">Cy_HPPASS_SAR_Init</a> or <a class="el" href="group__group__hppass__csg__functions.html#ga2f19f5ca7d25d29df462231b14e833b1">Cy_HPPASS_CSG_Init</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cfg</td><td>Pointer to structure containing configuration data for the entire High Performance Programmable Analog Sub-System, <a class="el" href="structcy__stc__hppass__cfg__t.html">cy_stc_hppass_cfg_t</a>. The pointer cannot be NULL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Combined value of all the subsystem statuses, <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">/* Scenario: Configure HPPASS to use SAR GROUP#0 with Chan#0 and FIR#0 to process the result from that conversion output */</span></div><div class="line"><span class="keyword">const</span> <a class="code" href="structcy__stc__hppass__fir__t.html">cy_stc_hppass_fir_t</a> firCfg =</div><div class="line">{</div><div class="line">    .<a class="code" href="structcy__stc__hppass__fir__t.html#ab20bac84d6c2144e7189cc92f815f7ca">chan</a>     = <a class="code" href="group__group__hppass__sar__enums.html#gga075c21d159c50ff7bb21b992f1a397b7a8a3672c5ef783bd4cd09b9ae10347641">CY_HPPASS_FIR_CHAN_0</a>,         <span class="comment">/* Use FIR channel #0 */</span></div><div class="line"></div><div class="line">    <span class="comment">/* Wait for 16 samples before the output is stored into a FIR_RESULT register */</span></div><div class="line">    .waitTapInit = <span class="keyword">true</span>,</div><div class="line"></div><div class="line">    <span class="comment">/* Test filter coeficients. Need to be updated, if particular filter type is needed. */</span></div><div class="line">    .coef        = {0x1000, 0x1000, 0x1000, 0x1000, 0x1000, 0x1000, 0x4000, 0x4000, 0x4000, 0x4000, 0x4000, 0x4000, 0x4000, 0x4000, 0x4000, 0x4000},</div><div class="line">    .limit    = <a class="code" href="group__group__hppass__sar__enums.html#gga761a8378e0f3b0eab1a27f8617d1c02eae8979b0849935acf47a6057472a8c377">CY_HPPASS_SAR_LIMIT_DISABLED</a>, <span class="comment">/* Limits are disabled */</span></div><div class="line">    .result      = <span class="keyword">true</span>,                         <span class="comment">/* FIR result is exposed to read */</span></div><div class="line">    .fifo     = <a class="code" href="group__group__hppass__sar__enums.html#ggaf90fa2a37e0fb7ef39e80b0c8c3179e9a27b52f62b23dd390c0f3317d106ade34">CY_HPPASS_FIFO_DISABLED</a>       <span class="comment">/* FIFO is disabled */</span></div><div class="line">};</div><div class="line"></div><div class="line"><span class="keyword">const</span> <a class="code" href="structcy__stc__hppass__sar__grp__t.html">cy_stc_hppass_sar_grp_t</a> grpCfg =</div><div class="line">{</div><div class="line">    .<a class="code" href="structcy__stc__hppass__sar__grp__t.html#a352c1fe5740afb64945f0f04dc707a0a">dirSampMsk</a>   = <a class="code" href="group__group__hppass__sar__direct__samplers.html#gaca3d7ea9142b4b797c01e88c2a98624d">CY_HPPASS_SAR_DIRECT_SAMP_0</a>,     <span class="comment">/* Use Direct sampler #0 */</span></div><div class="line">    .muxSampMsk   = <a class="code" href="group__group__hppass__sar__macros.html#gaa85a5aa2b1080d3631c8efee4d56ce9d">CY_HPPASS_SAR_SAMPLERS_DISABLED</a>, <span class="comment">/* Muxed samplers are not used */</span></div><div class="line">    .muxChanIdx      = {0, 0, 0, 0},                    <span class="comment">/* Muxed samplers are not used */</span></div><div class="line">    .trig     = <a class="code" href="group__group__hppass__sar__enums.html#ggafb345a3d451274c4b40309384dd07efcaf1c8e5026bb0f93d95f12a04ea073bcf">CY_HPPASS_SAR_TRIG_AC</a>,           <span class="comment">/* Use AC to trigger the Group */</span></div><div class="line">    .sampTime = <a class="code" href="group__group__hppass__sar__enums.html#ggaffa59d1aa8d36df32dca30f0afed2e0fac82612fac74208f8ac5ba8f776c0ddb2">CY_HPPASS_SAR_SAMP_TIME_0</a>,       <span class="comment">/* Use Sampler Timer #0 */</span></div><div class="line">    .priority    = <span class="keyword">false</span>,                           <span class="comment">/* Not used */</span></div><div class="line">    .continuous  = <span class="keyword">false</span>                            <span class="comment">/* Not used */</span></div><div class="line">};</div><div class="line"></div><div class="line"><span class="comment">/* Using default values for channel configuration */</span></div><div class="line"><a class="code" href="structcy__stc__hppass__sar__chan__t.html">cy_stc_hppass_sar_chan_t</a> chanCfg =</div><div class="line">{</div><div class="line">    .<a class="code" href="structcy__stc__hppass__sar__chan__t.html#a3cc40a1a5f02a50081870b542d4525b3">diff</a>        = <span class="keyword">false</span>,</div><div class="line">    .sign        = <span class="keyword">false</span>,</div><div class="line">    .avg         = <a class="code" href="group__group__hppass__sar__enums.html#ggae2f7574296597739ca43f2196bab0853a92843786edc02440f371b776a417c973">CY_HPPASS_SAR_AVG_DISABLED</a>,</div><div class="line">    .limit    = <a class="code" href="group__group__hppass__sar__enums.html#gga761a8378e0f3b0eab1a27f8617d1c02eae8979b0849935acf47a6057472a8c377">CY_HPPASS_SAR_LIMIT_DISABLED</a>,</div><div class="line">    .result      = <span class="keyword">false</span>,</div><div class="line">    .fifo     = <a class="code" href="group__group__hppass__sar__enums.html#ggaf90fa2a37e0fb7ef39e80b0c8c3179e9a27b52f62b23dd390c0f3317d106ade34">CY_HPPASS_FIFO_DISABLED</a></div><div class="line">};</div><div class="line"></div><div class="line"><a class="code" href="structcy__stc__hppass__sar__t.html">cy_stc_hppass_sar_t</a> sarCfg =</div><div class="line">{</div><div class="line">    .<a class="code" href="structcy__stc__hppass__sar__t.html#a89d3ae8c9d968982463d1f8096d30fb4">vref</a>        = <a class="code" href="group__group__hppass__sar__enums.html#ggad2d8f05def7ce065349e30631c34144fa091c21a6de9c6099d5f7cbbbc1e1a87a">CY_HPPASS_SAR_VREF_VDDA</a>,         <span class="comment">/* Use VDDA as reference */</span></div><div class="line">    .lowSupply   = <span class="keyword">false</span>,                           <span class="comment">/* Not used */</span></div><div class="line">    .offsetCal   = <span class="keyword">false</span>,                           <span class="comment">/* Not used */</span></div><div class="line">    .linearCal   = <span class="keyword">false</span>,                           <span class="comment">/* Not used */</span></div><div class="line">    .gainCal     = <span class="keyword">false</span>,                           <span class="comment">/* Not used */</span></div><div class="line">    .chanId      = <span class="keyword">false</span>,                           <span class="comment">/* Not used */</span></div><div class="line">    .dirSampEnMsk   = <a class="code" href="group__group__hppass__sar__direct__samplers.html#gaca3d7ea9142b4b797c01e88c2a98624d">CY_HPPASS_SAR_DIRECT_SAMP_0</a>,     <span class="comment">/* Use Direct sampler #0 */</span></div><div class="line">    .muxSampEnMsk   = <a class="code" href="group__group__hppass__sar__macros.html#gaa85a5aa2b1080d3631c8efee4d56ce9d">CY_HPPASS_SAR_SAMPLERS_DISABLED</a>, <span class="comment">/* Not used */</span></div><div class="line">    .holdCount   = 29,                              <span class="comment">/* Optimal value */</span></div><div class="line">    .aroute    = <span class="keyword">true</span>,                            <span class="comment">/* Default value */</span></div><div class="line"></div><div class="line">    <span class="comment">/* Default gain values */</span></div><div class="line">    .dirSampGain = {<a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>,</div><div class="line">                    <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>,</div><div class="line">                    <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, CY_HPPASS_SAR_SAMP_GAIN_1},</div><div class="line">    .muxSampGain = {<a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, <a class="code" href="group__group__hppass__sar__enums.html#gga11f649f48e0d846f657491a8d6a432e6a6cf95803fd841741b1815e64dc16de1e">CY_HPPASS_SAR_SAMP_GAIN_1</a>, CY_HPPASS_SAR_SAMP_GAIN_1},</div><div class="line">    .sampTime    = {47, 31, 31},                                                                            <span class="comment">/* Enough time for FIR to complete */</span></div><div class="line">    .chan        = {&amp;chanCfg, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, <span class="comment">/* Channel configuration structure */</span></div><div class="line">                    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL},</div><div class="line">    .grp         = {&amp;grpCfg, NULL, NULL, NULL, NULL, NULL, NULL, NULL},                                     <span class="comment">/* Group configuration structure */</span></div><div class="line">    .limit       = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL},                                        <span class="comment">/* Not used */</span></div><div class="line">    .muxMode     = {<a class="code" href="group__group__hppass__sar__enums.html#ggab8d45f2bf082e466df16caed456b727aa80cd4f6f2903e96a0f035e463a0c4b3c">CY_HPPASS_SAR_MUX_SEQ</a>, <a class="code" href="group__group__hppass__sar__enums.html#ggab8d45f2bf082e466df16caed456b727aa80cd4f6f2903e96a0f035e463a0c4b3c">CY_HPPASS_SAR_MUX_SEQ</a>, <a class="code" href="group__group__hppass__sar__enums.html#ggab8d45f2bf082e466df16caed456b727aa80cd4f6f2903e96a0f035e463a0c4b3c">CY_HPPASS_SAR_MUX_SEQ</a>, CY_HPPASS_SAR_MUX_SEQ}, <span class="comment">/* Recommended value */</span></div><div class="line">    .fir         = {&amp;firCfg, NULL},  <span class="comment">/* FIR configuration structure */</span></div><div class="line">    .<a class="code" href="structcy__stc__hppass__fir__t.html#af064ef0d6a9d0a46c98a5f670b501217">fifo</a>        = NULL                <span class="comment">/* Not used */</span></div><div class="line">};</div><div class="line"></div><div class="line"><span class="comment">/* HPPASS and AC state transition table configuration, used by Cy_HPPASS_Init API */</span></div><div class="line"><span class="keyword">const</span> <a class="code" href="structcy__stc__hppass__cfg__t.html">cy_stc_hppass_cfg_t</a> cfg =</div><div class="line">{</div><div class="line">    .<a class="code" href="structcy__stc__hppass__cfg__t.html#a3d2448daab68ef8b7c0568a4bc41a695">ac</a> =</div><div class="line">    {</div><div class="line">        .<a class="code" href="structcy__stc__hppass__ac__t.html#a366455c9d80a2dbb04d799ea75c34230">sttEntriesNum</a> = CY_HPPASS_STT_NUM_ENTRIES, <span class="comment">/* AC transition table size */</span></div><div class="line">        .stt = stateTransitionTable,                <span class="comment">/* AC transition table */</span></div><div class="line">        .gpioOutEnMsk = 0U,                          <span class="comment">/* GPIO contrlolled by AC is not used */</span></div><div class="line">        .startupClkDiv = 15U,                            <span class="comment">/* CLK_HF = 160MHz (CLK_INFRA = 80MHz) */</span></div><div class="line">        .startup =                  <span class="comment">/* Only one startup configuration is used */</span></div><div class="line">        {</div><div class="line">            {</div><div class="line">                .count    = 199U,   <span class="comment">/* Calculated value for startupClkDiv = 15 */</span></div><div class="line">                .sar      = <span class="keyword">true</span>,   <span class="comment">/* SAR is used */</span></div><div class="line">                .csgChan  = <span class="keyword">false</span>,  <span class="comment">/* CSG is not used */</span></div><div class="line">                .csgSlice = <span class="keyword">false</span>,  <span class="comment">/* CSG is not used */</span></div><div class="line">                .csgReady = <span class="keyword">false</span>   <span class="comment">/* CSG is not used */</span></div><div class="line">            },</div><div class="line">            {0},</div><div class="line">            {0},</div><div class="line">            {0}</div><div class="line">        }</div><div class="line">    },</div><div class="line">    .vref   = CY_HPPASS_VREF_LOCAL,</div><div class="line">    .csg       = NULL,                                                                              <span class="comment">/* CSG is not used */</span></div><div class="line">    .sar       = &amp;sarCfg,                                                                           <span class="comment">/* SAR configuration structure */</span></div><div class="line">    .trigIn    = {{0}, {0}, {0}, {0}, {0}, {0}, {0}, {0}},                                          <span class="comment">/* Triggers are not used */</span></div><div class="line">    .trigPulse = {<a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca33dd2eeebd4121262cca802d77172b76">CY_HPPASS_DISABLED</a>, <a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca33dd2eeebd4121262cca802d77172b76">CY_HPPASS_DISABLED</a>, <a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca33dd2eeebd4121262cca802d77172b76">CY_HPPASS_DISABLED</a>, <a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca33dd2eeebd4121262cca802d77172b76">CY_HPPASS_DISABLED</a>,   <span class="comment">/* Triggers are not used */</span></div><div class="line">                  <a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca33dd2eeebd4121262cca802d77172b76">CY_HPPASS_DISABLED</a>, <a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca33dd2eeebd4121262cca802d77172b76">CY_HPPASS_DISABLED</a>, <a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca33dd2eeebd4121262cca802d77172b76">CY_HPPASS_DISABLED</a>, CY_HPPASS_DISABLED},  <span class="comment">/* Triggers are not used */</span></div><div class="line">    .trigLevel = {{0}, {0}, {0}, {0}, {0}, {0}, {0}, {0}}                                           <span class="comment">/* Triggers are not used */</span></div><div class="line">};</div></div><!-- fragment --><div class="fragment"><div class="line">    <span class="comment">/* Initialize HPPASS */</span></div><div class="line">    <span class="keywordflow">if</span> (CY_HPPASS_SUCCESS != <a class="code" href="group__group__hppass__cfg__functions.html#ga8d22889d8dd8c3fd87df1db2869a6956">Cy_HPPASS_Init</a>(&amp;cfg))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Process the error */</span></div><div class="line">        printf(<span class="stringliteral">&quot;Cy_HPPASS_Init returns error\r\n&quot;</span>);</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga96d3f95d6f156ebfa816a43c3f98ef44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga96d3f95d6f156ebfa816a43c3f98ef44">&#9670;&nbsp;</a></span>Cy_HPPASS_DeInit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_HPPASS_DeInit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>De-initializes the AC, STT, AREF, SAR, CSG, and triggers register values to default. </p>
<dl class="section note"><dt>Note</dt><dd>This function stops and shuts down entire HPPASS including all the trims, calibrations, resets AC and STT flow and subsystems.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The HPPASS is initialized/working and then no longer used or needs to be deinit */</span></div><div class="line">    <a class="code" href="group__group__hppass__cfg__functions.html#ga96d3f95d6f156ebfa816a43c3f98ef44">Cy_HPPASS_DeInit</a>();</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga862fd1dd5ae54da1c040976abd98a62f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga862fd1dd5ae54da1c040976abd98a62f">&#9670;&nbsp;</a></span>Cy_HPPASS_DeepSleepCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_HPPASS_DeepSleepCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> *&#160;</td>
          <td class="paramname"><em>callbackParams</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>DeepSleep callback saves the SAR ADC calibration values before switch to deep sleep power mode and restore them after the wakeup. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">callbackParams</td><td>Callback parameters, see <a class="el" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a></td></tr>
    <tr><td class="paramname">mode</td><td>Callback mode, see <a class="el" href="group__group__syspm__data__enumerates.html#gae06cd8869fe61d709ad6145ca9f3cd63">cy_en_syspm_callback_mode_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a></dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The hardware must be suitably prepared to enter device Deep Sleep Mode */</span></div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__params__t.html">cy_stc_syspm_callback_params_t</a> hppass_Params;</div><div class="line">    <a class="code" href="structcy__stc__syspm__callback__t.html">cy_stc_syspm_callback_t</a> hppass_Callback = {<a class="code" href="group__group__hppass__cfg__functions.html#ga862fd1dd5ae54da1c040976abd98a62f">Cy_HPPASS_DeepSleepCallback</a>, <a class="code" href="group__group__syspm__data__enumerates.html#gga8c2960c0164ead1cfa86e7d6846b6ff0abc51d74deff0ceea4304b01b2d57bd9d">CY_SYSPM_DEEPSLEEP</a>, 0u, &amp;hppass_Params, NULL, NULL, 0};</div><div class="line"></div><div class="line">    <a class="code" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> syspmStatus = <a class="code" href="group__group__syspm__functions__callback.html#ga0d58b00c8dc764a6371590f70e2f73c7">Cy_SysPm_RegisterCallback</a>(&amp;hppass_Callback);</div><div class="line">    <span class="comment">/* Process returned syspmStatus */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gaa070f2bab6825033bdc4e2340bf1e282"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa070f2bab6825033bdc4e2340bf1e282">&#9670;&nbsp;</a></span>Cy_HPPASS_TriggerInConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_TriggerInConfig </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>trigIdx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcy__stc__hppass__trig__in__t.html">cy_stc_hppass_trig_in_t</a> *&#160;</td>
          <td class="paramname"><em>trig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the input trigger type and operation mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trigIdx</td><td>Trigger index. See <a class="el" href="group__group__hppass__triggers__indexes.html">Trigger Indexes</a>.</td></tr>
    <tr><td class="paramname">trig</td><td>Pointer to the input trigger structure. See <a class="el" href="structcy__stc__hppass__trig__in__t.html">cy_stc_hppass_trig_in_t</a>. The pointer cannot be NULL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status of operation, <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a>.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Select External HW Trigger#1 from A trigger inputs. Trigger is assumed to be asynchronous and used as a level trigger */</span></div><div class="line">    <span class="keyword">const</span> <a class="code" href="structcy__stc__hppass__trig__in__t.html">cy_stc_hppass_trig_in_t</a> trigInOne =</div><div class="line">    {</div><div class="line">        .<a class="code" href="structcy__stc__hppass__trig__in__t.html#a29e60eccee5a3293ab96c35010c17ec7">type</a> = <a class="code" href="group__group__hppass__enums.html#gga7b656d868df34bc35fca9580093fd86bae64deed0375d50a67360c091f472706f">CY_HPPASS_TR_HW_A</a>,</div><div class="line">        .hwMode = <a class="code" href="group__group__hppass__enums.html#gga1eb8a212c86efb9c4721cfb545fb026da39fc19e865376a5fe1c779547f502b80">CY_HPPASS_LEVEL_SINGLE_SYNC</a></div><div class="line">    };</div><div class="line"></div><div class="line">    status = <a class="code" href="group__group__hppass__cfg__functions.html#gaa070f2bab6825033bdc4e2340bf1e282">Cy_HPPASS_TriggerInConfig</a>(1U, &amp;trigInOne);</div><div class="line">    <span class="comment">/* Process returned status */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga31038e030330501dc11d754b27c6671d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31038e030330501dc11d754b27c6671d">&#9670;&nbsp;</a></span>Cy_HPPASS_TriggerOutLevelConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_TriggerOutLevelConfig </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>trigIdx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcy__stc__hppass__trig__out__level__t.html">cy_stc_hppass_trig_out_level_t</a> *&#160;</td>
          <td class="paramname"><em>trig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the LEVEL trigger output configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trigIdx</td><td>Trigger index. See <a class="el" href="group__group__hppass__triggers__indexes.html">Trigger Indexes</a>.</td></tr>
    <tr><td class="paramname">trig</td><td>Pointer to the output LEVEL trigger structure. See <a class="el" href="structcy__stc__hppass__trig__out__level__t.html">cy_stc_hppass_trig_out_level_t</a>. The pointer cannot be NULL.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Configure CMP#1 and SAR Limit detector #1 outputs to associated trigger, trigger is considered as asynchronous */</span></div><div class="line">    <span class="keyword">const</span> <a class="code" href="structcy__stc__hppass__trig__out__level__t.html">cy_stc_hppass_trig_out_level_t</a> outLevelOne =</div><div class="line">    {</div><div class="line">        .<a class="code" href="structcy__stc__hppass__trig__out__level__t.html#abb9f2cb7f2981a8c77724e5adcc0bbda">syncBypass</a> = <span class="keyword">true</span>,</div><div class="line">        .compMsk = <a class="code" href="group__group__hppass__triggers__out__level__masks.html#ga0f798017e403df8bbb70459349d9e37b">CY_HPPASS_TRIG_CMP_1</a>,</div><div class="line">        .limitMsk = <a class="code" href="group__group__hppass__triggers__out__level__masks.html#ga93b57f659f477f8bb3348ba56d412e88">CY_HPPASS_TRIG_SAR_LIM_1</a></div><div class="line">    };</div><div class="line"></div><div class="line">    status = <a class="code" href="group__group__hppass__cfg__functions.html#ga31038e030330501dc11d754b27c6671d">Cy_HPPASS_TriggerOutLevelConfig</a>(4U, &amp;outLevelOne);</div><div class="line">    <span class="comment">/* Process returned status */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga0401394988141183f29513df37860040"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0401394988141183f29513df37860040">&#9670;&nbsp;</a></span>Cy_HPPASS_TriggerOutPulseConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE <a class="el" href="group__group__hppass__enums.html#ga14c32a49b351302efcaf56b2e5075e00">cy_en_hppass_status_t</a> Cy_HPPASS_TriggerOutPulseConfig </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>trigIdx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__hppass__enums.html#gae8be0bf60b1685e83512c352328b34cc">cy_en_hppass_trig_out_pulse_t</a>&#160;</td>
          <td class="paramname"><em>trig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the PULSE trigger output configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trigIdx</td><td>Trigger index. See <a class="el" href="group__group__hppass__triggers__indexes.html">Trigger Indexes</a>.</td></tr>
    <tr><td class="paramname">trig</td><td>The PULSE trigger out select. See <a class="el" href="group__group__hppass__enums.html#gae8be0bf60b1685e83512c352328b34cc">cy_en_hppass_trig_out_pulse_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Initiate Trigger#3 when FIR#0 results are ready for reading */</span></div><div class="line">    status = <a class="code" href="group__group__hppass__cfg__functions.html#ga0401394988141183f29513df37860040">Cy_HPPASS_TriggerOutPulseConfig</a>(3U, <a class="code" href="group__group__hppass__enums.html#ggae8be0bf60b1685e83512c352328b34cca55e619fcb800749805522a4f67ee0ed7">CY_HPPASS_FIR_0</a>);</div><div class="line">    <span class="comment">/* Process returned status */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
